From cabe2f5f20f9705afb7526f415e5d18fcdc7b5e2 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sun, 28 Feb 2021 13:14:51 -0500 Subject: [PATCH] treelistrowsorter: Convert docs --- gtk/gtktreelistrowsorter.c | 37 +++++++++++++++++-------------------- 1 file changed, 17 insertions(+), 20 deletions(-) diff --git a/gtk/gtktreelistrowsorter.c b/gtk/gtktreelistrowsorter.c index cf19296a93..659a35bf21 100644 --- a/gtk/gtktreelistrowsorter.c +++ b/gtk/gtktreelistrowsorter.c @@ -28,24 +28,21 @@ #include "gtktypebuiltins.h" /** - * SECTION:gtktreelistrowsorter - * @title: GtkTreeListRowSorter - * @Short_description: Sort trees by levels - * @See_also: #GtkTreeListModel + * GtkTreeListRowSorter: * - * #GtkTreeListRowSorter is a special-purpose sorter that will apply a given - * sorter to the levels in a tree, while respecting the tree structure. + * `GtkTreeListRowSorter` is a special-purpose sorter that will apply a given + * sorter to the levels in a tree. * * Here is an example for setting up a column view with a tree model and - * a GtkTreeListSorter: + * a `GtkTreeListSorter`: * - * |[ + * ```c * column_sorter = gtk_column_view_get_sorter (view); * sorter = gtk_tree_list_row_sorter_new (g_object_ref (column_sorter)); * sort_model = gtk_sort_list_model_new (tree_model, sorter); * selection = gtk_single_selection_new (sort_model); * gtk_column_view_set_model (view, G_LIST_MODEL (selection)); - * ]| + * ``` */ struct _GtkTreeListRowSorter @@ -562,15 +559,15 @@ gtk_tree_list_row_sorter_init (GtkTreeListRowSorter *self) /** * gtk_tree_list_row_sorter_new: - * @sorter: (nullable) (transfer full): a #GtkSorter, or %NULL + * @sorter: (nullable) (transfer full): a `GtkSorter`, or %NULL * * Create a special-purpose sorter that applies the sorting - * of @sorter to the levels of a #GtkTreeListModel. + * of @sorter to the levels of a `GtkTreeListModel`. * - * Note that this sorter relies on #GtkTreeListModel:passthrough - * being %FALSE as it can only sort #GtkTreeListRows. + * Note that this sorter relies on [property@Gtk.TreeListModel:passthrough] + * being %FALSE as it can only sort [class@Gtk.TreeListRow]s. * - * Returns: a new #GtkTreeListRowSorter + * Returns: a new `GtkTreeListRowSorter` */ GtkTreeListRowSorter * gtk_tree_list_row_sorter_new (GtkSorter *sorter) @@ -590,14 +587,14 @@ gtk_tree_list_row_sorter_new (GtkSorter *sorter) /** * gtk_tree_list_row_sorter_set_sorter: - * @self: a #GtkTreeListRowSorter + * @self: a `GtkTreeListRowSorter` * @sorter: (nullable) (transfer none): The sorter to use, or %NULL * * Sets the sorter to use for items with the same parent. * - * This sorter will be passed the #GtkTreeListRow:item of the tree - * list rows passed to @self. - **/ + * This sorter will be passed the [property@Gtk.TreeListRow:item] of + * the tree list rows passed to @self. + */ void gtk_tree_list_row_sorter_set_sorter (GtkTreeListRowSorter *self, GtkSorter *sorter) @@ -623,12 +620,12 @@ gtk_tree_list_row_sorter_set_sorter (GtkTreeListRowSorter *self, /** * gtk_tree_list_row_sorter_get_sorter: - * @self: a #GtkTreeListRowSorter + * @self: a `GtkTreeListRowSorter` * * Returns the sorter used by @self. * * Returns: (transfer none) (nullable): the sorter used - **/ + */ GtkSorter * gtk_tree_list_row_sorter_get_sorter (GtkTreeListRowSorter *self) { -- 2.30.2